package com.lw.sbdemo2.common.config;

import lombok.extern.slf4j.Slf4j;
import org.springframework.core.NamedThreadLocal;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * <p>标题: 自定义拦截器</p>
 * <p>描述: 利用 NamedThreadLocal 记录拦截请求执行时间，这是Spring提供的一个命名的ThreadLocal实现</p>
 * <p>版权: Copyright (c) 2018</p>
 * <p>公司: 智业软件</p>
 *
 * @author LinWang
 * @date 2018-04-09 10:22
 */
@Slf4j
public class CustomInterceptor implements HandlerInterceptor {

    private NamedThreadLocal<Long> timeWatchThreadLocal = new NamedThreadLocal<Long>("timeWatch");

    /**
     * 1、preHandle方法是进行处理器拦截用的，顾名思义，该方法将在Controller处理之前（请求处理之前）进行调用；
     * SpringMVC中的Interceptor拦截器是链式的，可以同时存在多个Interceptor，然后根据声明的前后顺序一个接一个的执行；
     * 而且所有的Interceptor中的preHandle方法都会在Controller方法调用之前调用；
     * 2、只有该方法返回true，才会继续执行后续的Interceptor和Controller;
     * 当返回值为true 时就会继续调用下一个Interceptor的preHandle 方法，如果已经是最后一个Interceptor的时候就会是调用当前请求的Controller方法；
     * 3、SpringMVC的这种Interceptor链式结构也是可以进行中断的，这种中断方式是令preHandle的返回值为false，此时整个请求就结束了。
     */
    @Override
    public boolean preHandle(HttpServletRequest request,
                             HttpServletResponse response, Object handler) throws Exception {

        if (log.isInfoEnabled()) {
            //log.info("【CustomInterceptor】HandlerInterceptor拦截器preHandle");
        }

        //利用线程绑定变量，记录请求开始时间(该数据只有当前请求的线程可见）
        long beginTime = System.currentTimeMillis();
        timeWatchThreadLocal.set(beginTime);

        //继续流程
        return true;
    }

    /**
     * 这个方法只会在当前这个Interceptor的preHandle方法返回值为true的时候才会执行；
     * 该方法将在请求处理之后，DispatcherServlet进行视图返回渲染之前进行调用，可以在这个方法中对Controller 处理之后的ModelAndView 对象进行操作。
     * postHandle是进行处理器拦截用的，它的执行时间是在处理器进行处理之后，也就是在Controller的方法调用之后执行；
     * 但是它会在DispatcherServlet进行视图的渲染之前执行，也就是说在这个方法中你可以对ModelAndView进行操作。
     * 这个方法的链式结构跟正常访问的方向是相反的，也就是说先声明的Interceptor拦截器该方法反而会后调用，这跟Struts2里面的拦截器的执行过程有点像，
     * 只是Struts2里面的intercept方法中要手动的调用ActionInvocation的invoke方法，Struts2中调用ActionInvocation的invoke方法就是调用下一个Interceptor
     * 或者是调用action，然后要在Interceptor之前调用的内容都写在调用invoke之前，要在Interceptor之后调用的内容都写在调用invoke方法之后。
     */
    @Override
    public void postHandle(HttpServletRequest request,
                           HttpServletResponse response, Object handler,
                           ModelAndView modelAndView) throws Exception {

        if (log.isInfoEnabled()) {
            //log.info("【CustomInterceptor】HandlerInterceptor拦截器postHandle");
        }
    }

    /**
     * 该方法也是需要当前对应的Interceptor的preHandle方法的返回值为true时才会执行；
     * 该方法将在整个请求完成之后，也就是DispatcherServlet渲染了视图执行；
     * 这个方法的主要作用是用于清理资源的；
     */
    @Override
    public void afterCompletion(HttpServletRequest request,
                                HttpServletResponse response, Object handler, Exception ex) throws Exception {

        if (log.isInfoEnabled()) {
            //log.info("【CustomInterceptor】HandlerInterceptor拦截器afterCompletion");
        }

        //利用线程绑定变量，记录请求花费时间(该数据只有当前请求的线程可见）
        long consumeTime = System.currentTimeMillis() - timeWatchThreadLocal.get();
        //log.info("【CustomInterceptor】请求{}花费时间：{}ms", request.getRequestURI(), consumeTime);

        //若处理时间超过500毫秒的请求为慢请求
        if (consumeTime > 500) {
            //TODO 记录到日志文件
            //log.warn(String.format("%s consume %d millis", request.getRequestURI(), consumeTime));
        }
    }
}